home *** CD-ROM | disk | FTP | other *** search
/ SGI Hot Mix 17 / Hot Mix 17.iso / HM17_SGI / research / examples / misc / template.pro < prev    next >
Text File  |  1997-07-08  |  3KB  |  99 lines
  1. ; $Id: template.pro,v 1.1 1997/04/01 19:41:45 doug Exp $
  2. ;
  3. ; Copyright (c) 1994, Research Systems, Inc.  All rights reserved.
  4. ;    Unauthorized reproduction prohibited.
  5. ; (Of course, if you don't work for RSI, remove these lines or
  6. ;  modify to suit.)
  7. ;+
  8. ; NAME:
  9. ;    ROUTINE_NAME
  10. ;
  11. ; PURPOSE:
  12. ;    Tell what your routine does here.  I like to start with the words:
  13. ;    "This function (or procedure) ..."
  14. ;    Try to use the active, present tense.
  15. ;
  16. ; CATEGORY:
  17. ;    Put a category (or categories) here.  For example:
  18. ;    Widgets.
  19. ;
  20. ; CALLING SEQUENCE:
  21. ;    Write the calling sequence here. Include only positional parameters
  22. ;    (i.e., NO KEYWORDS). For procedures, use the form:
  23. ;
  24. ;    ROUTINE_NAME, Parameter1, Parameter2, Foobar
  25. ;
  26. ;    Note that the routine name is ALL CAPS and arguments have Initial
  27. ;    Caps.  For functions, use the form:
  28. ; 
  29. ;    Result = FUNCTION_NAME(Parameter1, Parameter2, Foobar)
  30. ;
  31. ;    Always use the "Result = " part to begin. This makes it super-obvious
  32. ;    to the user that this routine is a function!
  33. ;
  34. ; INPUTS:
  35. ;    Parm1:    Describe the positional input parameters here. Note again
  36. ;        that positional parameters are shown with Initial Caps.
  37. ;
  38. ; OPTIONAL INPUTS:
  39. ;    Parm2:    Describe optional inputs here. If you don't have any, just
  40. ;        delete this section.
  41. ;    
  42. ; KEYWORD PARAMETERS:
  43. ;    KEY1:    Document keyword parameters like this. Note that the keyword
  44. ;        is shown in ALL CAPS!
  45. ;
  46. ;    KEY2:    Yet another keyword. Try to use the active, present tense
  47. ;        when describing your keywords.  For example, if this keyword
  48. ;        is just a set or unset flag, say something like:
  49. ;        "Set this keyword to use foobar subfloatation. The default
  50. ;         is foobar superfloatation."
  51. ;
  52. ; OUTPUTS:
  53. ;    Describe any outputs here.  For example, "This function returns the
  54. ;    foobar superflimpt version of the input array."  This is where you
  55. ;    should also document the return value for functions.
  56. ;
  57. ; OPTIONAL OUTPUTS:
  58. ;    Describe optional outputs here.  If the routine doesn't have any, 
  59. ;    just delete this section.
  60. ;
  61. ; COMMON BLOCKS:
  62. ;    BLOCK1:    Describe any common blocks here. If there are no COMMON
  63. ;        blocks, just delete this entry.
  64. ;
  65. ; SIDE EFFECTS:
  66. ;    Describe "side effects" here.  There aren't any?  Well, just delete
  67. ;    this entry.
  68. ;
  69. ; RESTRICTIONS:
  70. ;    Describe any "restrictions" here.  Delete this section if there are
  71. ;    no important restrictions.
  72. ;
  73. ; PROCEDURE:
  74. ;    You can describe the foobar superfloatation method being used here.
  75. ;    You might not need this section for your routine.
  76. ;
  77. ; EXAMPLE:
  78. ;    Please provide a simple example here. An example from the PICKFILE
  79. ;    documentation is shown below.
  80. ;
  81. ;    Create a PICKFILE widget that lets users select only files with 
  82. ;    the extensions 'pro' and 'dat'.  Use the 'Select File to Read' title 
  83. ;    and store the name of the selected file in the variable F.  Enter:
  84. ;
  85. ;        F = PICKFILE(/READ, FILTER = ['pro', 'dat'])
  86. ;
  87. ; MODIFICATION HISTORY:
  88. ;     Written by:    Your name here, Date.
  89. ;    July, 1994    Any additional mods get described here.  Remember to
  90. ;            change the stuff above if you add a new keyword or
  91. ;            something!
  92. ;-
  93.  
  94. PRO TEMPLATE
  95.  
  96.   PRINT, "This is an example header file for documenting IDL routines"
  97.  
  98. END
  99.